Foxit PDF RDK
|
Class UIExtensionsManager
represents a UI extensions manager.
The UIExtensionsManager
class is mainly used for the UI extensions which implement IPDFReader interface, it implements the IPDFUIExtensionsManager interface that is a listener to listen common interaction events and view event, and will dispatch some events to UI extensions, it also defines functions to manage the UI extensions.
uiextensions.UIExtensionsManager.canAddAnnot | ( | ) |
Check whether the document can add annotation
uiextensions.UIExtensionsManager.canAssemble | ( | ) |
Check whether the document can be assemble.
uiextensions.UIExtensionsManager.canModifyContents | ( | ) |
Check whether the document can be modified.
uiextensions.UIExtensionsManager.canUpdateAnnotDefaultProperties | ( | ) |
Whether to update the default properties of creating annot.
uiextensions.UIExtensionsManager.enableAutoFullScreen | ( | enable | ) |
Set whether to automatically full screen, the default is true.
enable | If you set true, it will automatically full screen after a few seconds, hiding topbar and bottommbar,false otherwise. |
uiextensions.UIExtensionsManager.enableBottomToolbar | ( | isEnabled | ) |
Whether show the bottom tool bar
isEnabled | True show the bottom tool bar, or otherwise. |
uiextensions.UIExtensionsManager.enableFormHighlight | ( | enable | ) |
Enable the highlight color of form field. If the document is opened, please call function PDFViewCtrl#updatePagesLayout() after setting the new value.
enable | True means highlight color of form field. can be displayed, false for else. |
uiextensions.UIExtensionsManager.enableLinkHighlight | ( | enable | ) |
Enable highlight color of link annotation
enable | True means highlight color of link annotation can be displayed, false for else. |
uiextensions.UIExtensionsManager.enableLinks | ( | enable | ) |
Enable link annotation action event.
enable | True means link annotation action event can be triggered, false for else. |
uiextensions.UIExtensionsManager.enableModification | ( | isEnabled | ) |
Set whether the pdf document can be modified. The default is allow modification.
isEnabled | whether the pdf document can be modified |
uiextensions.UIExtensionsManager.enableSmallBottomToolbar | ( | isEnabled | ) |
Enable or disable small bottom toolbar.
isEnabled | Whether small bottom toolbar is enabled or not. |
uiextensions.UIExtensionsManager.enableSmallTopToolbar | ( | isEnabled | ) |
Enable or disable small top toolbar.
isEnabled | Whether small top toolbar is enabled or not. |
uiextensions.UIExtensionsManager.enableTopToolbar | ( | isEnabled | ) |
Whether show the top tool bar
isEnabled | True show the top tool bar, or otherwise. |
uiextensions.UIExtensionsManager.exitPanZoomMode | ( | ) |
Exit the pan zoom mode.
uiextensions.UIExtensionsManager.getAnnotAuthor | ( | ) |
Get annotation author string. The default author is "foxit sdk"
uiextensions.UIExtensionsManager.getAnnotHandlerByType | ( | type | ) |
Get the specified AnnotHandler from current UI extensions manager.
type | The type of AnnotHandler, refer to AnnotHandler#getType(); |
uiextensions.UIExtensionsManager.getConfig | ( | ) |
Get a property config
uiextensions.UIExtensionsManager.getCurrentAnnotHandler | ( | ) |
uiextensions.UIExtensionsManager.getCurrentSelectedText | ( | ) |
Get current selected text content from text select tool handler.
uiextensions.UIExtensionsManager.getCurrentToolHandler | ( | ) |
Get the current tool handler.
ToolHandler
object which specifies the current tool handler. uiextensions.UIExtensionsManager.getFormHighlightColor | ( | ) |
Get the highlight color of form field.
uiextensions.UIExtensionsManager.getLinkHighlightColor | ( | ) |
get the highlight color of link annotation.
uiextensions.UIExtensionsManager.getModuleByName | ( | name | ) |
Get the specified module from current UI extensions manager.
name | The specified module name, refer to Module#getName(). |
Module
object with specified module name. uiextensions.UIExtensionsManager.getNightColorMode | ( | ) |
Get the night color mode.
uiextensions.UIExtensionsManager.getPageColorMode | ( | ) |
Get the page color mode.
uiextensions.UIExtensionsManager.getPanelManager | ( | ) |
Get the interface to handle the creation, display, hiding, layout, and interaction of panels.
uiextensions.UIExtensionsManager.getPDFViewCtrlModel | ( | ) |
Receive and handle the single tap event.
motionEvent | MotionEvent object which species the event. |
uiextensions.UIExtensionsManager.getSaveDocFlag | ( | ) |
Get the flag while saving a document has used
uiextensions.UIExtensionsManager.getSavePath | ( | ) |
uiextensions.UIExtensionsManager.getSaveWriter | ( | ) |
uiextensions.UIExtensionsManager.getSelectionHighlightColor | ( | ) |
Get highlight color (including alpha) when text has selected.
uiextensions.UIExtensionsManager.getToolHandlerByType | ( | type | ) |
get the specified ToolHandler from current UI extensions manager.
type | The tool handler type, refer to function ToolHandler#getType(). |
ToolHandler
object with specified type. uiextensions.UIExtensionsManager.isAutoSaveDoc | ( | ) |
Returns true if the document is automatically saved.
uiextensions.UIExtensionsManager.isContinueAddAnnot | ( | ) |
Whether or not the annotation can be created continuously.
True
the annotation can be created continuously or otherwise. uiextensions.UIExtensionsManager.isEnableModification | ( | ) |
whether the pdf document can be modified
uiextensions.UIExtensionsManager.isFormHighlightEnable | ( | ) |
Check whether form highlight can be displayed.
uiextensions.UIExtensionsManager.isLinkHighlightEnabled | ( | ) |
Check whether link highlight can be display.
uiextensions.UIExtensionsManager.isLinksEnabled | ( | ) |
Check whether link annotation action event can be triggered.
uiextensions.UIExtensionsManager.isLoadAnnotModule | ( | annot | ) |
Check whether the specified annotation module that is loaded.
uiextensions.UIExtensionsManager.isUseLogicalPageNumbers | ( | ) |
Whether to use logical pages.
uiextensions.UIExtensionsManager.onBackPress | ( | ) |
Handles the back button press event.
true
, indicating that the back press event is handled. uiextensions.UIExtensionsManager.onXFAPageRemoved | ( | isSuccess | , |
pageIndex | |||
) |
Called when the specified xfa page has removed.
uiextensions.UIExtensionsManager.onXFAPagesInserted | ( | isSuccess | , |
pageIndex | |||
) |
Called when a xfa page has added in the specified position.
uiextensions.UIExtensionsManager.onXFAWidgetAdded | ( | xfaWidget | ) |
Called when a XFAWidget has added.
uiextensions.UIExtensionsManager.onXFAWidgetWillRemove | ( | xfaWidget | ) |
Called when a XFAWidget will be removed.
uiextensions.UIExtensionsManager.openDocument | ( | path | , |
password | , | ||
cb(errorCode); | |||
) |
Open a PDF document from a specified PDF file path.
path | A PDF file path. |
password | A byte array which specifies the password used to load the PDF document content. It can be either user password or owner password. If the PDF document is not encrypted by password, just pass an empty string. |
cb | The callback will be called when current document object becomes available or the view control fail to open the document FoxitRDKNative.ErrorCode. |
uiextensions.UIExtensionsManager.registerAnnotHandler | ( | handler | ) |
Register the specified AnnotHandler to current UI extensions manager.
handler | A AnnotHandler to use. |
uiextensions.UIExtensionsManager.registerDocModifiedEventListener | ( | listener | ) |
Register a document modified event listener.
listener | An IDocModifiedEventListener object to be registered. |
uiextensions.UIExtensionsManager.registerInteractionListener | ( | listener | ) |
Register a callback to be invoked when the interaction event happened.
listener | the interaction event IInteractionEventListener |
uiextensions.UIExtensionsManager.registerLifecycleListener | ( | listener | ) |
Register the specified ILifecycleEventListener
uiextensions.UIExtensionsManager.registerMenuEventListener | ( | listener | ) |
Register a callback to be invoked when the menu event has triggered.
uiextensions.UIExtensionsManager.registerModule | ( | module | ) |
Register the specified module to current UI extensions manager.
Note: This method is only used within RDK
module | A Module object to be registered. |
uiextensions.UIExtensionsManager.registerStateChangeListener | ( | listener | ) |
Register the specified IStateChangeListener
uiextensions.UIExtensionsManager.registerToolHandler | ( | handler | ) |
Register the specified ToolHandler to current UI extensions manager.
handler | A ToolHandler object to be registered. |
uiextensions.UIExtensionsManager.registerToolHandlerChangedListener | ( | listener | ) |
Register a callback to be invoked when the tool handler changed.
Note: This method is only used within RDK
uiextensions.UIExtensionsManager.registerXFAPageEventListener | ( | listener | ) |
Register a xfa page event listener.
listener | An IPageEventListener object to be registered. |
uiextensions.UIExtensionsManager.registerXFAWidgetEventListener | ( | listener | ) |
Register a xfa widget event listener.
listener | An IXFAWidgetEventListener object to be registered. |
uiextensions.UIExtensionsManager.setAnnotAuthor | ( | author | ) |
Set annotation author
author | the author string to be set |
uiextensions.UIExtensionsManager.setAutoSaveDoc | ( | autoSaveDoc | ) |
Set to automatically save the document to the original file
autoSaveDoc | True auto save document, false otherwise. |
uiextensions.UIExtensionsManager.setContinueAddAnnot | ( | continueAddAnnot | ) |
Set whether the annotation can be created continuously. The default is false.
continueAddAnnot | whether the annot can be created continuously. |
uiextensions.UIExtensionsManager.setCurrentToolHandler | ( | toolHandler | ) |
Set the current tool handler.
toolHandler | A ToolHandler object which specifies the current tool handler. |
uiextensions.UIExtensionsManager.setFilePath | ( | path | ) |
Set the file path
uiextensions.UIExtensionsManager.setFormHighlightColor | ( | color | ) |
Set form highlight color. If the document is opened, please call function PDFViewCtrl#updatePagesLayout() after setting the new value.
color | the form highlight color to be set |
uiextensions.UIExtensionsManager.setLinkHighlightColor | ( | color | ) |
Set the highlight color of link annotation.
color | the highlight color to be set |
uiextensions.UIExtensionsManager.setNightColorMode | ( | nightColorMode | ) |
Set the night color mode.
nightColorMode | The night color mode. It should be one of NightColorMode.DEFAULT, NightColorMode.MAPPING_GRAY. |
uiextensions.UIExtensionsManager.setOnFinishListener | ( | listener | ) |
Set the OnFinishListener to be invoked when the document closed and current activity has exited.
listener | the OnFinishListener to use. |
uiextensions.UIExtensionsManager.setPageColorMode | ( | pageColorMode | ) |
Set the page color mode.
pageColorMode | The page color mode. It should be one of NightColorMode.DEFAULT, NightColorMode.MAPPING_GRAY. |
uiextensions.UIExtensionsManager.setSaveDocFlag | ( | flag | ) |
Set the flag to be used when the document has saved
uiextensions.UIExtensionsManager.setSavePath | ( | savePath | ) |
Set the path where the document will be saved
uiextensions.UIExtensionsManager.setSaveWriter | ( | writer | ) |
set the file writer callback where the document will be saved.
writer | File writer callbackFileWriterCallback for the new saved PDF file. |
uiextensions.UIExtensionsManager.setSelectionHighlightColor | ( | color | ) |
Set highlight color (including alpha) when select text.
color | The highlight color to be set. |
uiextensions.UIExtensionsManager.setUpdateAnnotDefaultProperties | ( | update | ) |
Set whether to update the default properties of creating annot.
update | True if you modify some properties of an annot, those properties will be used the next time when you create the same type of annot, false otherwise. |
uiextensions.UIExtensionsManager.setUseLogicalPageNumbers | ( | useLogicalPageNumbers | ) |
Whether to use logical pages, default is false.
useLogicalPageNumbers | True means use logical page numbers, false for else. |
uiextensions.UIExtensionsManager.triggerDismissMenuEvent | ( | ) |
Called when menu has dismissed.
uiextensions.UIExtensionsManager.unregisterAnnotHandler | ( | handler | ) |
Unregister the specified AnnotHandler from current UI extensions manager.
handler | A AnnotHandler to use. |
uiextensions.UIExtensionsManager.unregisterDocModifiedEventListener | ( | listener | ) |
Unregister a document modified event listener.
listener | An IDocModifiedEventListener object to be unregistered. |
uiextensions.UIExtensionsManager.unregisterInteractionListener | ( | listener | ) |
Unregister the interaction event listener.
listener | the interaction event IInteractionEventListener |
uiextensions.UIExtensionsManager.unregisterLifecycleListener | ( | listener | ) |
Unregister the specified ILifecycleEventListener
uiextensions.UIExtensionsManager.unregisterMenuEventListener | ( | listener | ) |
Unregister the specified MenuEventListener
uiextensions.UIExtensionsManager.unregisterModule | ( | module | ) |
Unregister the specified module from current UI extensions manager. Note: This method is only used within RDK
module | A Module object to be unregistered. |
uiextensions.UIExtensionsManager.unregisterStateChangeListener | ( | listener | ) |
Unregister the specified IStateChangeListener
uiextensions.UIExtensionsManager.unregisterToolHandler | ( | handler | ) |
Unregister the specified ToolHandler from current UI extensions manager.
Note: This method is only used within RDK
handler | A ToolHandler object to be unregistered. |
uiextensions.UIExtensionsManager.unregisterToolHandlerChangedListener | ( | listener | ) |
Unregister the ToolHandler changed listener.
Note: This method is only used within RDK
listener | a ToolHandlerChangedListener to use. |
uiextensions.UIExtensionsManager.unregisterXFAPageEventListener | ( | listener | ) |
Unregister a xfa page event listener.
listener | An IPageEventListener object to be unregistered. |
uiextensions.UIExtensionsManager.unregisterXFAWidgetEventListener | ( | listener | ) |
Unregister a xfa widget event listener.
listener | An IXFAWidgetEventListener object to be unregistered. |